Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for filter search in OpenSearch #7900

Merged

Conversation

leanneeliatra
Copy link
Contributor

@leanneeliatra leanneeliatra commented Aug 2, 2024

Description

Adding a new page to the documentation for Filtering Search Results in OpenSearch

Issues Resolved

Part of #7507

Version

all

Frontend features

n/a

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Aug 2, 2024

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress backport 2.15 labels Aug 2, 2024
@hdhalter hdhalter assigned rishabhmaurya and unassigned hdhalter Aug 2, 2024
@leanneeliatra
Copy link
Contributor Author

leanneeliatra commented Aug 7, 2024

This is ready for review please cc @hdhalter, @Naarcha-AWS

@hdhalter hdhalter added the search-and-query Issue: Issues related to search and query features label Aug 7, 2024
@vagimeli
Copy link
Contributor

vagimeli commented Aug 28, 2024

@jainankitk @msfroh @sgup432 @kaushalmahi12 Will one of you provide technical review and approval of this PR? Following your review, we'll move this forward to get it published. Thank you for your support.

@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress Needs SME Waiting on input from subject matter expert labels Oct 15, 2024
Signed-off-by: Melissa Vagi <[email protected]>

You can filter search using different methods, each suited to specific scenarios. You can apply filters at the query level, using `boolean` query clauses, as well as by using `post_filter` and `aggregation` level filters.

## Query-level filtering with boolean queries
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Query-level filtering with boolean queries
## Query-level filtering with Boolean queries

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leanneeliatra @vagimeli Please see my comment and changes and let me know if you have any questions. Thanks!

_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
## Refining aggregrations with aggregation-level filtering

You can use aggregation-level filtering to apply filters to specific aggregations, without affecting the overall aggregation.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Above: "without affecting the main aggregation to which they belong"?

_search-plugins/filter-search.md Outdated Show resolved Hide resolved
_search-plugins/filter-search.md Outdated Show resolved Hide resolved
vagimeli and others added 10 commits October 16, 2024 08:16
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli vagimeli merged commit 4770a47 into opensearch-project:main Oct 16, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 16, 2024
* adding documentation for filter search in OpenSearch

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Heather Halter <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update filter-search.md

Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Incorporating review comments.

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit 4770a47)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
leanneeliatra added a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
…ect#7900)

* adding documentation for filter search in OpenSearch

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Heather Halter <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update filter-search.md

Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Incorporating review comments.

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
leanneeliatra added a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this pull request Oct 17, 2024
…ect#7900)

* adding documentation for filter search in OpenSearch

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Heather Halter <[email protected]>

* reviewdog updates

Signed-off-by: [email protected] <[email protected]>

* Update filter-search.md

Doc review completed

Signed-off-by: Melissa Vagi <[email protected]>

* Incorporating review comments.

Signed-off-by: [email protected] <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _search-plugins/filter-search.md

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress backport 2.17 Backport for version 2.17 search-and-query Issue: Issues related to search and query features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants